Skip to main content
GET
/
v1
/
shipping
/
shipments
/
{id}
/
reservations
Get Shipment Reservations
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/reservations \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "id": 12345,
      "quantity": 2.5,
      "qty_picked": 0,
      "is_locked": true,
      "location": {
        "id": 42
      },
      "item": {
        "id": 123,
        "product": {
          "id": 3
        }
      }
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
id
integer<int32>
required

The shipment ID

Required range: x >= 1

Query Parameters

ā€‹
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

ā€‹
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

ā€‹
sort
string

The default sort order is descending by primary key (sort=-id).

Using the sorting syntax, the following fields are available for sorting:

  • id
  • quantity
  • qty_picked
Pattern: ^-?\w+(,-?\w+)*$
ā€‹
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • location_id
  • product_id
  • qty
  • qty_picked
  • is_locked
ā€‹
fields
enum<string>[]

Specify additional fields to include in the response

Available options:
all,
basic,
quantity,
is_locked,
location,
item,
qty_picked
ā€‹
fields:item
enum<string>[]

Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
sku,
product,
quantity,
qty_shipped,
qty_picked,
qty_canceled,
qty_cancel_requested,
order_item,
reservations
ā€‹
fields:item.product
enum<string>[]

Specify additional fields of the Product objects to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
basic,
all,
created_at,
updated_at,
container_options,
supplies_options,
data_collection_options,
instruction_options,
infill_options,
vendor_sku,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
ā€‹
fields:item.order_item
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

Available options:
all,
order_item_ref,
qty_ordered,
qty_assigned,
qty_allocated,
qty_backordered,
qty_processing,
qty_picked,
qty_shipped,
qty_cancel_requested,
qty_canceled,
row_weight
ā€‹
fields:location
enum<string>[]

Specify additional fields of the Location object to be included in the response.

Available options:
basic,
all,
label,
priority,
qty_on_hand,
qty_putaway,
qty_unreserved,
qty_reserved,
qty_locked,
is_temp,
is_pickable,
is_type_auto,
created_at,
updated_at,
last_cyclecount_at,
lot,
product,
rack,
location_type
ā€‹
fields:location.lot
enum<string>[]

Specify additional fields of the Lot object to be included in the response.

Available options:
basic,
all,
id,
lot_number,
origination_date,
expiration_date,
is_expired,
is_active,
lot_number_input,
expiration_input,
sort_value,
days_until_expiration,
sort_direction,
group_value,
created_at,
updated_at,
created_by,
lot_type,
product
ā€‹
fields:location.location_type
enum<string>[]

Specify additional fields of the LocationType object (via Location) to be included in the response. See the selecting fields page for more information. Specify additional fields of the LocationType object to be included in the response.

Available options:
basic,
all,
name,
is_pickable,
slot_dimensions,
created_at,
updated_at
ā€‹
fields:location.product
enum<string>[]

Specify additional fields of the Product object (via Location) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
basic,
all,
created_at,
updated_at,
container_options,
supplies_options,
data_collection_options,
instruction_options,
infill_options,
vendor_sku,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
ā€‹
fields:location.rack
enum<string>[]

Specify additional fields of the Rack object (via Location) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Rack object to be included in the response.

Available options:
all,
id,
name,
rack_type,
location_pattern,
picking_order,
warehouse

Response

A dictionary with a collection property that contains a list of Reservation objects for the specified shipment.

ā€‹
collection
Reservation Ā· object[]

A list of Reservation objects.